package com.tedu.egweibo.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * SpringBoot项目的配置类，用于框架整合时为那些框架提供的starter提供配置信息
 *
 * @Configuration注解，让当前类作为SpringBoot的配置类，可以在上面定义
 *                   配置信息，SpringBoot在启动时会采用这些配置来初始化并启动
 *
 * @MapperScan 为Mybatis的初始化注解，用于告知Mybatis启动时扫描哪个包
 *                 这个包(包括其子孙包)中的所有类都是Mapper，这样我们就无需为
 *                 每个Mapper添加@Mapper注解了
 *
 * @EnableSwagger2WebMvc  允许Swgger(knife4j)为当前项目生成文档网站
 */
@Configuration
@MapperScan("com.tedu.egweibo.mapper")
@EnableSwagger2WebMvc
public class Config {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                //用来配置文档信息
                .apiInfo(apiInfo())
                //用于定义为我们项目的哪个包下的类生成文档(通常仅指定controller包)
                .select().apis(RequestHandlerSelectors.basePackage("com.tedu.egweibo.controller"))
                //指定为哪些url生成文档，这里为所有
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                    //当前项目的名字(生成的文档网页的标题)
                   .title("微博项目课堂版")
                    //当前项目的描述(文档描述)
                   .description("微博项目在线API文档课堂版")
                    //文档版本
                   .version("1.0")
                    //联系人
                   .contact(new Contact("吴羽","2678459676@qq.com","2678459676@qq.com"))
                    //生成文档信息
                   .build();
    }

}








